package com.badger.generator.base.service;

import java.util.List;

import org.springframework.stereotype.Service;

import com.badger.generator.base.entity.PageInfo;

import tk.mybatis.mapper.entity.Example;

/**
 * 通用service接口
 * @author liqi
 * @param <T> 实体泛型
 */
@Service
public interface BaseService<T> {
    /**
     * 保存一个实体，null的属性也会保存，不会使用数据库默认值
     * @param entity
     * @return
     */
    void save(T entity);

    /**
     * 根据主键字段进行删除，方法参数必须包含完整的主键属性
     * @param key
     * @return
     */
    void deleteByKey(Object key);

    /**
     * 根据实体属性作为条件进行删除，查询条件使用等号
     * @param entity
     * @return
     */
    void delete(T entity);

    /**
     * 根据主键更新属性不为null的值
     * @param entity
     * @return
     */
    void updateNotNull(T entity);

    /**
     * 根据Example条件更新实体`entity`包含的不是null的属性值
     * @param entity
     * @param example
     * @return
     */
    void updateByExampleSelective(T entity, Object example);

    /**
     * 根据主键字段进行查询，方法参数必须包含完整的主键属性，查询条件使用等号
     * @param key
     * @return
     */
    T selectByKey(Object key);

    /**
     * 根据Example条件进行查询
     * @param example
     * @return
     */
    List<T> selectByExample(Object example);

    /**
     * 查询全部结果
     * @return
     */
    List<T> selectAll();

    /**
     * 根据实体中的属性值进行查询，查询条件使用等号
     * @param entity
     * @return
     */
    List<T> select(T entity);

    /**
     * 根据查询条件，查询单条数据，多少数据的情况下，只取第一条，查询不到，返回泛型的空对象
     * @param entity
     * @return
     */
    T selectOne(T entity);

    /**
     * 根据example 条件，查询分页数据
     * @param example
     * @param page 当前第几页
     * @param pageSize 每页多少条
     * @return
     */
    PageInfo<T> selectPageInfo(Example example, Integer page, Integer pageSize);

    /**
     * 根据实体的 条件，查询分页数据
     * @param entity 实体
     * @param page 当前第几页
     * @param pageSize 每页多少条
     * @return
     */
    PageInfo<T> selectPageInfo(T entity, Integer page, Integer pageSize);

}
